docs: pull the diff update guide out of the README - #180
Merged
Conversation
Sections 4-2 and 6 between them carried the whole story of publishing a patch update: the build hook for each platform, how to archive what it exports, how to release against it, and what asset diffs need on top. Both leave the install flow. Section 4-2 goes entirely, since asset diffs have nothing to do with the wrapper section 4 sets up, and section 6 becomes a pointer named after the topic rather than after one step of it. docs/diff-updates.md holds the guide in the order a reader meets it: the two kinds of difference a release can offer, exporting the embedded bundle, then asset diff archives. The advantages list at the top gains diff updates, which it never mentioned, and links to the guide. Inbound links follow the content: cli/README.md, cli/README.ko.md and both telemetry callback documents now point at it.
docs/diff-updates.ko.md carries the same sections, tables and examples as the English guide, and the two link to each other from the top. Code comments are in Korean, since the guide is read by Korean readers. The Korean CLI README and the Korean telemetry document now point at it instead of at the English guide, so a Korean reader stays in Korean.
Several sentences leaned on a demonstrative whose antecedent sat dozens of lines away, in a different table row, or nowhere in the sentence at all: "the record" for a binary-patch-base.json named 56 lines earlier, "that download" for the row above it, a plural pronoun for a pair of nouns. Each one now names the thing. Five in the Korean diff update guide, two in the Korean telemetry document, and the two that read the same way in the English originals.
Member
Author
|
The new docs still need some work to make them easier to understand. Since it looks like this will take some time, I’ll merge this PR for now and work on improving them over the weekend. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README carried the whole story of publishing a patch update across two sections: the build hook for each platform, how to archive what it exports, how to release against it, and what asset diffs need on top. That is deployment reference material, and it pushed the install guide out of the way.
What
docs/diff-updates.md(new) — the guide, in the order a reader meets it: the two kinds of difference a release can offer, exporting the embedded bundle (Android Gradle script, iOS build phase, archiving per binary version, releasing with--binary-bundle-path), then asset diff archives (the order a client tries archives in, and the three conditions that publish diffs).docs/diff-updates.ko.md(new) — the same guide in Korean. The two link to each other from the top and match section for section: 7 headings, 5 code blocks, and the same table.README.md— 640 → 526 lines. Section 4-2 is gone (asset diffs have nothing to do with the wrapper section 4 sets up) and section 6 becomes6. Diff Updates (Optional), a single pointer to the guide. The advantages list at the top gains a Diff Updates entry, which it never had, linking to the same guide.cli/README.md,cli/README.ko.mdand both telemetry callback documents now point at the guide. The Korean documents point at the Korean guide.Notes
the recordfor abinary-patch-base.jsonnamed 56 lines earlier,that downloadfor the table row above it.cli/commands/releaseCommand/release.ts(binaryPatch && bundleDownloader && diffBaseCount > 0).